Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Integrated HypEx, Updated Tutorials, Improved Docs, and Removed Legacy Code #170

Merged
merged 16 commits into from
Dec 19, 2024

Conversation

tikhomirovd
Copy link
Contributor

🚀 feat: Integrated HypEx, updated tutorials, improved docs, and cleaned legacy code

Description:

This PR introduces improvements to LightAutoML by integrating HypEx as an optional dependency, restructuring tutorials, and removing legacy HypEx code.


1. Integrated HypEx as an Optional Dependency:

Changes Made:

  • Removed all legacy HypEx code from LightAutoML.
  • Created a new __init__.py in lightautoml/addons/hypex with dynamic imports that mirror the original HypEx structure.
  • Added hypex as an optional dependency in pyproject.toml.
  • Configured intersphinx to link HypEx documentation.

2. Updated Tutorials:

Path: examples/tutorials/

New Tutorials Created:

  • Tutorial_12_AA_Test.ipynb
  • Tutorial_13_AA_Test_multigroup_split.ipynb
  • Tutorial_14_AB_Test.ipynb
  • Tutorial_15_Matching.ipynb
  • Tutorial_16_Matching_without_replacement.ipynb
  • Tutorial_17_Modeling_Limit_Distribution.ipynb
  • Tutorial_18_Test_Limit_Distribution.ipynb

3. Updated Documentation:

File Modified: docs/pages/Tutorials.rst

What’s Done:

  • Added links to all newly created tutorials.
  • Reorganized Tutorials.rst:
    • Sections:
      • LightAutoML Tutorials with subgroups:
        • Core Features
        • Advanced Topics
      • HypEx Tutorials with subgroups:
        • A/B and A/A Testing
        • Matching and Filtering
        • Modeling and Testing Limits
    • Updated paths for all .nblink files.

4. Created .nblink Files:

Path: docs/pages/tutorials/

Automatically Generated Files:

  • Tutorial_12_AA_Test.nblink
  • Tutorial_13_AA_Test_multigroup_split.nblink
  • Tutorial_14_AB_Test.nblink
  • Tutorial_15_Matching.nblink
  • Tutorial_16_Matching_without_replacement.nblink
  • Tutorial_17_Modeling_Limit_Distribution.nblink
  • Tutorial_18_Test_Limit_Distribution.nblink

5. Code Style and Linting Fixes:

  • Applied codespell to fix typos.
  • Excluded generated and documentation files from spell checking.

How to Test:

  1. Run Full Project Check:

    tox
  2. Check Documentation Only:

    tox -e docs
    open docs/_build/html/index.html  # macOS
  3. Expected Results:

    • Tutorials should be visible and correctly linked in the documentation.
    • All imports from lightautoml.addons.hypex should work seamlessly.
    • No build errors or missing dependencies should occur.

Notes for Reviewers:

  • The tutorials have been validated with updated imports and correct functionality.
  • The HypEx integration keeps LightAutoML modular while ensuring full backward compatibility.

@tikhomirovd tikhomirovd changed the title Update hypex Integrated HypEx, Updated Tutorials, Improved Docs, and Removed Legacy Code Dec 18, 2024
@dev-rinchin dev-rinchin merged commit 3c09457 into sb-ai-lab:master Dec 19, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants